/*
*  Copyright (c) 2001 Sun Microsystems, Inc.  All rights
*  reserved.
*
*  Redistribution and use in source and binary forms, with or without
*  modification, are permitted provided that the following conditions
*  are met:
*
*  1. Redistributions of source code must retain the above copyright
*  notice, this list of conditions and the following disclaimer.
*
*  2. Redistributions in binary form must reproduce the above copyright
*  notice, this list of conditions and the following discalimer in
*  the documentation and/or other materials provided with the
*  distribution.
*
*  3. The end-user documentation included with the redistribution,
*  if any, must include the following acknowledgment:
*  "This product includes software developed by the
*  Sun Microsystems, Inc. for Project JXTA."
*  Alternately, this acknowledgment may appear in the software itself,
*  if and wherever such third-party acknowledgments normally appear.
*
*  4. The names "Sun", "Sun Microsystems, Inc.", "JXTA" and "Project JXTA"
*  must not be used to endorse or promote products derived from this
*  software without prior written permission. For written
*  permission, please contact Project JXTA at http://www.jxta.org.
*
*  5. Products derived from this software may not be called "JXTA",
*  nor may "JXTA" appear in their name, without prior written
*  permission of Sun.
*
*  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
*  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
*  OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
*  DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
*  ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
*  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
*  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
*  USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
*  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
*  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
*  OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
*  SUCH DAMAGE.
*  ====================================================================
*
*  This software consists of voluntary contributions made by many
*  individuals on behalf of Project JXTA.  For more
*  information on Project JXTA, please see
*  <http://www.jxta.org/>.
*
*  This license is based on the BSD license adopted by the Apache Foundation.
*
*  $Id: ManyToManyDialog.java,v 1.11 2007/06/10 21:15:12 nano Exp $
*/

package net.jxta.myjxta.plugins.groupchat;

import net.jxta.endpoint.Message;
import net.jxta.endpoint.StringMessageElement;
import net.jxta.logging.Logging;
import net.jxta.myjxta.MyJXTA;
import net.jxta.myjxta.View;
import net.jxta.myjxta.dialog.*;
import net.jxta.myjxta.dialog.filter.*;
import net.jxta.myjxta.dialog.listener.NewDialogListener;
import net.jxta.myjxta.plugin.PluginView;
import net.jxta.myjxta.ui.ChatDialogView;
import net.jxta.myjxta.util.Group;
import net.jxta.myjxta.util.GroupListener;
import net.jxta.peergroup.PeerGroup;
import net.jxta.pipe.OutputPipe;
import net.jxta.pipe.PipeID;
import net.jxta.pipe.PipeService;
import net.jxta.protocol.PipeAdvertisement;
import net.jxta.util.JxtaBiDiPipe;

import java.io.IOException;
import java.util.EventObject;
import java.util.HashMap;
import java.util.Map;
import java.util.logging.Level;
import java.util.logging.Logger;

/**
 * @author james todd [gonzo at jxta dot org]
 * @author mike mcangus [mcangus at jxta dot org]
 * @version $Id: ManyToManyDialog.java,v 1.11 2007/06/10 21:15:12 nano Exp $
 */

public final class ManyToManyDialog
        extends Dialog
        implements DialogPipeListener {

    public static final String SEQ_NR_MSGKEY = "SEQ_NR";
    //    public static boolean ACTIVATE_SEQNR=System.getProperty("DEBUG_MSG_SEQ_NR","false").equalsIgnoreCase("true");
    public static boolean ACTIVATE_SEQNR = true;
    public static final String IMFREE_NAME = "";
    private static final String prefix = "JxtaTalk";
    public static final DialogKeys KEYS = new DialogKeys(prefix + "SenderName", prefix + "Message",
            prefix + "SenderMessage", prefix + "GroupId", "GrpName",
            prefix + "Command");
    private static final Logger LOG = Logger.getLogger(ManyToManyDialog.class.getName());

    /**
     * The OutputPipe on which to propagate messages
     */
    private OutputPipe pipe = null;

    /**
     * A cache of pipe we already opened
     */
    private Map<PipeAdvertisement, OutputPipe> pipeCache = null;

    private int m_lastMessageDispatchNumber = 0;
    private ChatDialogView dialogPanel;

    //the listener that is informed about group connected / disconnected events
    private final GroupListener myGroupListener;

    static {
        DIALOG_NAME = IMFREE_NAME;
    }

    /**
     * Create a new group dialog
     *
     * @param group  the Group in which this group chat takes place
     * @param pa     The PipeAdvertisement to be used by the Dialog
     *               for joining the MyJXTA group.
     * @param myJxta the MyJXTA instance to use
     */
    public ManyToManyDialog(Group group, PipeAdvertisement pa,
                            MyJXTA myJxta) {
        super(myJxta, pa, group);
        PeerGroup pg = getGroup().getPeerGroup();

        setDialogMessage(new DialogMessage(pg.getPeerName(), null,
                pg.getPeerGroupID().toString(), pg.getPeerGroupName(), KEYS));

        // retrieve the correct instance of the DialogManager
        DialogManager dm = DialogManager.getInstance(group,
                Dialog.getDialogNamer(ManyToManyDialog.class).
                        getDialogName(pg.getPeerName()),
                PipeService.PropagateType);

        dm.addPipeListener(pg, this);

        // Create the OutputPipe to propate messages
        OutputPipe pipe = getPipe(pa);

        // initialize the pipe
        if (pipe == null) {
            try {
                pipe = pg.getPipeService().createOutputPipe(pa, 100);

                setPipe(pa, pipe);
            } catch (IOException ioe) {
                LOG.log(Level.SEVERE, "Caught unexpected Exception", ioe);
            }
        } else {
            setPipe(null, pipe);
        }

        // update the DialogMessage template to report the
        // correct  PeerGroup name
        DialogMessage dmsg = getDialogMessage();

        dmsg.setLabel(dmsg.getGroupName());

        setDialogMessage(dmsg);
        addListener(new NewDialogListener(getGroup(), getMyJXTA()));
        myGroupListener = new GroupListener() {
            public void groupEvent(Group g, String s, EventObject p_sourceEvent) {
                updateConnectionState();
            }
        };
        group.addListener(myGroupListener);

        init();
    }

    private void updateConnectionState() {
        if (this.dialogPanel != null)
            this.dialogPanel.updateConnectionState();
    }


    /**
     * close: cut all the strings attached to this Dialog.
     */
    public void close() {

        if (m_closed)
            return;

        if (Logging.SHOW_FINE && LOG.isLoggable(Level.FINE)) {
            LOG.fine("Begin close()");
        }


        if (this.pipe != null && !m_closed) {
            DialogMessage goodbyeMsg = (DialogMessage) getDialogMessage().clone();
            goodbyeMsg.setCommand(GOODBYE_CMD);
            try {
                final Group group2 = getGroup();
                if (group2 != null) {
                    final PipeID ownPeersCommandId = group2.getOwnPeersCommandId();
                    if (ownPeersCommandId != null) {
                        goodbyeMsg.addMessageElement("COMMAND_PIPE", new StringMessageElement(Dialog.IMFREE + "CommandPipe", ownPeersCommandId.toString(), null));
                    }
                }
            } catch (Exception e) {
                //nothing
                //safety catch because this has been added 1 day before the 2.4 release
            }
            //goodbyeMsg.setHtmlMessage("*** has left ***");
            dispatch(goodbyeMsg);
        }

        clear();

        if (this.myGroupListener != null) {
            getGroup().removeListener(myGroupListener);
        }

        // retrieve the correct instance of the DialogManager
        DialogManager dm = DialogManager.getInstance(getGroup(), getGroup().getPeerGroup().getPeerName(), PipeService.PropagateType);

        dm.removePipeListener(getGroup().getPeerGroup(), this);

        // close the pipe
        if (this.pipe != null) {
            pipe.close();
            setPipe(null, null);
        }
        this.dialogPanel = null;
        super.close();
    }

    public PluginView getDialogPanel(View p_myJXTAView) {
        this.dialogPanel = new ChatDialogView(p_myJXTAView, this);
        return dialogPanel;
    }

    /**
     * Dispatch a Message object to the intended receivers.
     * This imeplementation send the message down the pipe.
     *
     * @param msg the Message object to send across an open pipe
     * @return <code>true</code> if no Exceptions are encountered while sending
     *         the data over the pipe, <code>false</code> otherwise.
     */
    public boolean dispatch(Message msg) {
        boolean isDispatched = false;

        if (ACTIVATE_SEQNR) {
            if (msg.getMessageElement(SEQ_NR_MSGKEY) == null) {
                msg.addMessageElement(new StringMessageElement(SEQ_NR_MSGKEY, Integer.toString(m_lastMessageDispatchNumber), null));
            }
        }


        try {
            this.pipe.send(msg);

            isDispatched = true;
        } catch (IOException ioe) {
            LOG.log(Level.SEVERE, "Caught unexpected Exception", ioe);
        }

        if (Logging.SHOW_FINE && LOG.isLoggable(Level.FINE)) {
            LOG.fine("End   dispatch(Message)");
        }
        return isDispatched;
    }

    /**
     * Perform any task  that need to be performed after the
     * Message object was send. This implementation does nothing
     *
     * @param msg the Message object that was send
     */
    protected void postDispatch(Message msg) {
        // Currently, nothing is done after dispatch.
        m_lastMessageDispatchNumber++;
    }

    /**
     * Perform any tasks that need to be performed before all
     * registered DialogListeners are informed that a new DialogMessage
     * object was received. This implementation does not make any
     * changes in the DialogMessage object
     *
     * @param dm the DialogMessage object that was received
     * @return the changed DialogMessage image is any
     */
    protected DialogMessage preReceive(DialogMessage dm) {
        return dm;
    }

    /**
     * Sets up all the inbound and outbound filters used by
     * this Dialog.
     */
    private void init() {
        // xxx: consider varying filters per dialog in time (eg prefs)
        BanFilter banFilter = new BanFilter();
        banFilter.setValid(true);
        addInboundFilter(banFilter);

        URIFilter uriFilter = new URIFilter();
        uriFilter.setValid(true);
        addInboundFilter(uriFilter);

        LegacyAnnounceFilter legacyAnnounceFilter = new LegacyAnnounceFilter();
        legacyAnnounceFilter.setValid(false);
        addInboundFilter(legacyAnnounceFilter);

        PingPresenceFilter pingFilter = new PingPresenceFilter();
        pingFilter.setValid(false);
        addInboundFilter(pingFilter);

        EmoticonFilter emoticonFilter = new EmoticonFilter();
        emoticonFilter.setValid(true);
        addInboundFilter(emoticonFilter);

        HTMLNormalizerFilter htmlNormalizerFilter = new HTMLNormalizerFilter();
        htmlNormalizerFilter.setValid(true);
        addInboundFilter(htmlNormalizerFilter);

        // xxx: encode has "issues"
        //this.outbound.addFilter(new EncodeFilter());
        EmptyMessageOrCommandFilter emptyMessageOrCommandFilter = new EmptyMessageOrCommandFilter();
        emptyMessageOrCommandFilter.setValid(true);
        addInboundFilter(emptyMessageOrCommandFilter);

        EmptyMessageFilter emptyMessageFilter = new EmptyMessageFilter();
        emptyMessageFilter.setValid(true);
        addOutboundFilter(emptyMessageFilter);

        DirectiveFilter directiveFilter = new DirectiveFilter(getGroup());
        directiveFilter.setValid(true);
        addOutboundFilter(directiveFilter);

        if (Logging.SHOW_FINE && LOG.isLoggable(Level.FINE)) {
            LOG.fine("banFilter.isValid()                   = " +
                    banFilter.isValid());
            LOG.fine("directiveFilter.isValid()             = " +
                    directiveFilter.isValid());
            LOG.fine("emoticonFilter.isValid()              = " +
                    emoticonFilter.isValid());
            LOG.fine("emptyMessageFilter.isValid()          = " +
                    emptyMessageFilter.isValid());
            LOG.fine("emptyMessageOrCommandFilter.isValid() = " +
                    emptyMessageOrCommandFilter.isValid());
            LOG.fine("htmlNormalizerFilter.isValid()        = " +
                    htmlNormalizerFilter.isValid());
            LOG.fine("legacyAnnounceFilter.isValid()        = " +
                    legacyAnnounceFilter.isValid());
            LOG.fine("pingFilter.isValid()                  = " +
                    pingFilter.isValid());
            LOG.fine("uriFilter.isValid()                   = " +
                    uriFilter.isValid());


            LOG.fine("End   init()");
        }
    }

    /**
     * Checks whether the desired OutputPipe was already
     * created and is currently in our cache
     *
     * @param pa the PipeAdvertisement of the desired pipe
     * @return an OutputPipe object if it existed in our cache, null
     *         otherwise
     */
    private OutputPipe getPipe(PipeAdvertisement pa) {
        return (this.pipeCache != null &&
                this.pipeCache.containsKey(pa) ?
                this.pipeCache.get(pa) : null);
    }

    /**
     * Updates the {@link #pipe pipe} member variable and
     * adds the pipe to the cache if it was not already added
     *
     * @param pa   the PipeAdvertisement describing the pipe
     * @param pipe the OutputPipe to use to send  messages
     */
    private void setPipe(PipeAdvertisement pa, OutputPipe pipe) {
        // set the pipe member variable
        this.pipe = pipe;

        // put the pipe in the cache if need be
        if (pa != null) {
            if (this.pipeCache == null) {
                this.pipeCache = new HashMap<PipeAdvertisement, OutputPipe>();
            }

            if (!this.pipeCache.containsKey(pa)) {
                this.pipeCache.put(pa, this.pipe);
            }
        }

        // change the connection status of this Dialog

    }

    public boolean isConnected() {
        //if we arent connected to the group (to the rdv of the group) propagation pipes
        //are not working --> not connected until we are connected to the group
        return this.pipe != null && !this.pipe.isClosed() && this.getGroup().isConnected();
    }

    // DialogPipeListener methods

    /**
     * Called if a new Message object was received
     *
     * @param pg  the PeerGroup in which this message was send
     * @param msg the newly received message
     */
    public void receive(PeerGroup pg, Message msg) {
        // xxx: what of pg
        receive(msg);
    }

    /**
     * Called if a new JxtaBiDiPipe was opened for the indicated
     * PeerGroup. This implementation does nothing
     *
     * @param pg   the PeerGroup in which this  pipe was opened
     * @param pipe the JxtaBiDiPipe on which messages are send
     */
    public void receive(PeerGroup pg, JxtaBiDiPipe pipe) {
        // Currently, BiDi Pipes are ignored.
    }

}
